Allow to set response headers on error pages #39
Conversation
|
Pull request for ez systems: |
|
@pkamps If we want to avoid the HTTPName BC break Gaetano mentioned in the original PR, we could just retain HTTPName it and restructure the code. Move it in place as a fallback so that HeaderList takes precedence if available and rework the old HTTPName logic so it uses the $Result['responseHeaders'] array the HeaderList coded uses. That way installations using the old setting would continue to work and other installations could use the new setting as it takes priority. The PR also has a ToDo still in place if that's not too involved maybe that can be done as part of this PR too? |
|
I changed the approach so that it is not breaking backwards compatibility. It will use all HeaderList settings and in case there still is a deprecated _ HTTPName_ setting, it will that HTTPName for the response 'Status'. The rest of the code is like before. I decided not to implement the TODO note I added in this pull request. The variable $Result['responseHeaders'] is maybe used later in the code execution - that's why I don't want to replace it with the PHP function http_response_code(). There is a risk of regression issues if I would do it. |
|
@benkmugo Could you recheck please? See my previous comment for updates. |
|
Tested the new setting as well as the fallback for the now removed HTTPName setting. Good to go from my end. |
In ezp it's not possible to set custom response headers for error pages. ezp only allows you to set response headers by requested URLs (see HTTPHeaderSettings in site.ini).
This pull request allows you to specify custom response header for error pages on ezp. That's an important feature in case your site is behind a reverse proxy (CDN akamai, CloudFront, Varnish) and you control the caching TTLs with response headers.
You can test this pull request by accessing a URL that does not exists. From that request you should get a response with this header: 'Cache-Control:public, must-revalidate, max-age=300'
The only small complexity in this pull request is the fact that we re-use the 'Status' header in order to build the response status code - for example '404 Not Found'.